v5.0.0

Compare Source

This release significantly bumps the supported versions of core dependencies:

‼️ Breaking Changes

This release updates the minimum supported versions:

• Python: >=3.11 (dropped Python 3.10, tests up to 3.14)
• Sphinx: >=8,<10 (dropped Sphinx 7, added Sphinx 9)
• Docutils: >=0.20,<0.23 (dropped docutils 0.19, added docutils 0.22)
• markdown-it-py: ~=4.0 (upgraded from v3)

⬆️ Dependency Upgrades

• ⬆️ Upgrade to markdown-it-py v4 by gh-user:chrisjsewell in gh-pr:1060
• ⬆️ Drop Python 3.10 and Sphinx 7 by gh-user:chrisjsewell in gh-pr:1059
• ⬆️ Drop docutils 0.19 by gh-user:chrisjsewell in gh-pr:1061
• ⬆️ Add support for Python 3.14 by gh-user:chrisjsewell in gh-pr:1075
• ⬆️ Support Sphinx v9 by gh-user:chrisjsewell in gh-pr:1076
• ⬆️ Allow docutils 0.22 by gh-user:chrisjsewell in gh-pr:1084

👌 Improvements

• 👌 Improve generation of meta nodes by gh-user:AA-Turner in gh-pr:1080

📚 Documentation

• 📚 Fix typo in tables.md by gh-user:electricalgorithm in gh-pr:1034
• 📚 Fix minor typo in cross-referencing.md by gh-user:krassowski in gh-pr:1036

🔧 Internal / Maintenance

• 🔧 Update pre-commit by gh-user:chrisjsewell in gh-pr:1058
• 🔧 Add AGENTS.md by gh-user:chrisjsewell in gh-pr:1083

Full Changelog: v4.0.1...v5.0.0

v4.0.1

Compare Source

🔧 Minor fix for Sphinx 8.2 compatibility (in gh-pr:1013)

v4.0.0

Compare Source

This release bumps the supported versions of:

• Python to 3.10 and greater
• Sphinx to >=7,<9
• Docutils to >=0.19,<0.22

Additionally, footnotes are now parsed similar to the corresponding reStructuredText, in that resolution (between definitions and references) and ordering is now deferred to transforms on the doctree (in gh-pr:931).

This allows for the proper interaction with other docutils/sphinx transforms, including those that perform translations,
and logging of warnings for duplicate/unreferenced footnote definitions and also for footnote references with no definitions.

See the footnotes guide for more information.

Full Changelog: v3.0.1...v4.0.0

v3.0.1

Compare Source

🐛 Bug Fixes

• Account for the final directive option having an empty value, by gh-user:chrisjsewell in gh-pr:924
• Re-allow indented directive option blocks, by gh-user:chrisjsewell in gh-pr:925

Full Changelog: v3.0.0...v3.0.1

v3.0.0

Compare Source

Upgraded dependencies

• ⬆️ Add support for Python 3.12 by gh-user:hugovk in gh-pr:848
• ⬆️ Update docutils requirement from >=0.16,<0.21 to >=0.18,<0.22 by gh-user:chrisjsewell in gh-pr:916

New features

• ✨ Allow for use of the line-block directive by gh-user:chrisjsewell in gh-pr:900
• ✨ Emits sphinx include-read event by gh-user:sumezulike in gh-pr:887

Improvements

• 👌 Nested parse attribution in attr_block by gh-user:chrisjsewell in gh-pr:831
• 👌 Directive option parsing by gh-user:chrisjsewell in <gh-pr:796
• 👌 Improve directive parsing warnings by gh-user:chrisjsewell in gh-pr:893
• 👌 Allow for opening external links in new tabs (#​856) by gh-user:marjus45 in gh-pr:857

Internal

• 🔧 Replace black, isort, pyupgrade with ruff formatter by gh-user:chrisjsewell in gh-pr:833
• 🔧 remove redundant mypy config by gh-user:danieleades in gh-pr:866
• 🔧 Add additional Ruff lints (and fix issues) by gh-user:danieleades in gh-pr:862
• 🔧 mypy- disallow 'any generics' by gh-user:danieleades in gh-pr:865
• 🔧 Fix docutils deprecation in option parsing by gh-user:agoose77 in gh-pr:842

Documentation

• 📚 Fix a broken link in configuration.md by gh-user:zupo in gh-pr:907
• 📚 Add linkify dependency to contributing docs. by gh-user:jhcole in gh-pr:792
• 📚 Fix the double used in docs/syntax/math.md by gh-user:ice-tong in gh-pr:810
• 📚 Also add linkify to pip install command in README by gh-user:n-peugnet in gh-pr:851
• 📚 Fix the code section title in live preview by gh-user:BoboTiG in gh-pr:875
• 📚 Fix admonition example by gh-user:72757373656c6c in gh-pr:904
• 📚 Fix url for jupyter book gallery by gh-user:72757373656c6c in gh-pr:905
• 📚 Update theme version by gh-user:chrisjsewell in gh-pr:918
• 📚 Fix typo by gh-user:blakeNaccarato in gh-pr:911
• 📚 Fix architecture typo (#​855) by gh-user:72757373656c6c in gh-pr:910

Full Changelog: v2.0.0...v3.0.0